@turf/ellipse

@turf/ellipse

ellipse

Takes a Point and calculates the ellipse polygon given two semi-axes expressed in variable units and steps for precision.

Parameters

• center Coord center point
• xSemiAxis number semi (major) axis of the ellipse along the x-axis
• ySemiAxis number semi (minor) axis of the ellipse along the y-axis
• options Object Optional parameters (optional, default {})
  • options.angle number angle of rotation (along the vertical axis), from North in decimal degrees, negative clockwise (optional, default 0)
  • options.pivot Coord point around which the rotation will be performed (optional, default 'origin')
  • options.steps number number of steps (optional, default 64)
  • options.units string unit of measurement for axes (optional, default 'kilometers')
  • options.properties Object properties (optional, default {})

Examples

var center = [-75, 40];
var xSemiAxis = 5;
var ySemiAxis = 2;
var ellipse = turf.ellipse(center, xSemiAxis, ySemiAxis);

//addToMap
var addToMap = [turf.point(center), ellipse]

Returns Feature<Polygon> ellipse polygon

---

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @turf/ellipse

Or install the Turf module that includes it as a function:

$ npm install @turf/turf

Changelog

6.5.0

🏅 New Features/Enhancements

• @turf/points-with-polygon Add MultiPoint support (PR https://github.com/Turfjs/turf/pull/2137 - Author @twelch)

🐛 Bug Fixes

• @turf/dissolve Complete rewrite of the dissolve module to resolve many bugs (PR https://github.com/Turfjs/turf/pull/2110 - Author @rowanwins)

• @turf/mask Complete rewrite of the mask module to resolve many bugs (PR https://github.com/Turfjs/turf/pull/2130 - Author @rowanwins)

• @turf/boolean-valid Add missing dependency to (PR https://github.com/Turfjs/turf/pull/2094 - Author @rycgar)

📖 Documentation

• @turf/boolean-overlap Improve clarity (PR https://github.com/Turfjs/turf/pull/2133 - Author @patrickbrett)

🔔 Misc

• Enable TS Strict Mode (PR https://github.com/Turfjs/turf/pull/2126 - Author @mfedderly)